Leave Channel
AutomatR.Slack.Activities.LeaveChannel
The "Leave Channel" activity in AutomatR is part of the Slack Channel activities package, utilizing the Slack API to enable you to leave a channel that you're currently a member of. This activity supports seamless channel management within automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Channel Name | The name of the channel from which to leave. String variables containing the desired channel name. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Leave Channel" activity. Integer variables containing the delay duration. Example: If the amount of time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Result | Outputs a Boolean value indicating whether the user successfully left the channel. True indicates success, while False indicates failure. Variables of relevant types (e.g., Boolean variables) to store the operation result. |
How to use:
- Drag and drop the "Leave Channel" activity onto the workflow.
- Configure the properties by specifying the channel name.
- Optionally, configure the delay.
- Execute the workflow to leave the specified channel.
Example: Consider an example where the "Leave Channel" activity is used to leave the "General" channel:
Leave Channel:
Delay: 2
Channel Name: "General"
Result: leaveResult
In this example, the activity attempts to leave the "General" channel with a 2-second delay. The result of the operation (success or failure) is stored in the Boolean variable "leaveResult" for further handling in the workflow.